# -------------------------------------------------------------
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
# -------------------------------------------------------------

# Autogenerated By   : src/main/python/generator/generator.py
# Autogenerated From : scripts/builtin/frameSort.dml

from typing import Dict, Iterable

from systemds.operator import OperationNode, Matrix, Frame, List, MultiReturn, Scalar
from systemds.script_building.dag import OutputType
from systemds.utils.consts import VALID_INPUT_TYPES


def frameSort(F: Frame,
              mask: Matrix,
              **kwargs: Dict[str, VALID_INPUT_TYPES]):
    """
     Related to [SYSTEMDS-2662] dependency function for cleaning pipelines
     Built-in for sorting frames
    
    
    
    :param F: Data frame of string values
    :param mask: matrix for identifying string columns
    :return: sorted dataset by column 1 in decreasing order
    """

    params_dict = {'F': F, 'mask': mask}
    params_dict.update(kwargs)
    return Matrix(F.sds_context,
        'frameSort',
        named_input_nodes=params_dict)
